Operation FileManager.ImportWithProperties (Create Document from file)
In component org.nuxeo.ecm.core.automation.features.operations
Description
Create Document(s) from Blob(s) using the FileManagerService and set multiple properties on them.The destination container must be passed in a Context variable named currentDocument.
The properties are specified as key=value pairs separated by a new line. The key used for a property is the property xpath. To specify multi-line values you can use a \ character followed by a new line.
Example:
dc:title=The Document TitleFor updating a date, you will need to expose the value as ISO 8601 format, for instance :
dc:description=foo bar
Example:
dc:title=The Document Title
dc:issued=@{org.nuxeo.ecm.core.schema.utils.DateParser.formatW3CDateTime(CurrentDate.date)}
Returns back the updated document.
To update a multi-valued field with multiple values:
custom:multivalued=a,b,c,d
Operation id | FileManager.ImportWithProperties |
---|---|
Category | Services |
Label | Create Document from file |
Requires | |
Since |
Parameters
Name | Description | Type | Required | Default value |
---|---|---|---|---|
properties | properties | yes | ||
mimeTypeCheck | Whether to check the blob's mime-type against the file name, defaults to true | boolean | no | |
overwrite | Whether to overwrite an existing file with the same title, defaults to false | boolean | no |
Signature
Inputs | bloblist, blob |
---|---|
Outputs | documents, document |
Implementation Information
Implementation Class | Class: org.nuxeo.ecm.automation.core.operations.services.FileManagerImportWithProperties |
---|---|
Contributing Component | org.nuxeo.ecm.core.automation.features.operations |
JSON Definition
{ "id" : "FileManager.ImportWithProperties", "label" : "Create Document from file", "category" : "Services", "requires" : null, "description" : "Create Document(s) from Blob(s) using the FileManagerService and set multiple properties on them.The destination container must be passed in a Context variable named currentDocument. <p>The properties are specified as <i>key=value</i> pairs separated by a new line. The key used for a property is the property xpath. To specify multi-line values you can use a \\ character followed by a new line. <p>Example:<pre>dc:title=The Document Title<br>dc:description=foo bar</pre>For updating a date, you will need to expose the value as ISO 8601 format, for instance : <p>Example:<pre>dc:title=The Document Title<br>dc:issued=@{org.nuxeo.ecm.core.schema.utils.DateParser.formatW3CDateTime(CurrentDate.date)}</pre><p>Returns back the updated document.<p>To update a multi-valued field with multiple values:<pre>custom:multivalued=a,b,c,d</pre>", "url" : "FileManager.ImportWithProperties", "signature" : [ "bloblist", "documents", "blob", "document" ], "params" : [ { "name" : "properties", "description" : null, "type" : "properties", "required" : true, "widget" : null, "order" : 0, "values" : [ ] }, { "name" : "mimeTypeCheck", "description" : "Whether to check the blob's mime-type against the file name, defaults to true", "type" : "boolean", "required" : false, "widget" : null, "order" : 0, "values" : [ ] }, { "name" : "overwrite", "description" : "Whether to overwrite an existing file with the same title, defaults to false", "type" : "boolean", "required" : false, "widget" : null, "order" : 0, "values" : [ ] } ] }